Quake2 Typing Model v2.0
------------------------

Author: Paul Bowlay
E-Mail: otser@yahoo.com
WebUrl: http://members.tripod.com/~bowlay/



Legal And Distribution Info
---------------------------

This model is (c) 1998 by Paul Bowlay (aka "Otser").  Permission is
granted to re-distribute it via any method that is NOT commercial!
Any commercial distribution is strictly forbidden due to ID Software's
License Agreement for Quake2.



Important Notes
---------------

This archive is a direct replacement for my previous Typing Model
release that had the filename "Typing.zip" with a size of 807 K.
If you have downloaded that version and NOT YET INSTALLED IT, THEN
DO NOT DO SO -- INSTALL THIS VERSION INSTEAD.

In the previous release of the Typing Model, there was a bug that
stopped it from working properly if you used the keyboard to move
forward (this bug didn't affect mouse or joystick controls that moved
forward).  This bug has been fixed in this release.

This Typing Model will only work in Deathmatch by default.  To get it
working with other mods (such as CTF, Jailbreak, etc) you must fully
and carefully read the installation instructions below.

If you install the Typing Model, you will NOT be able to use any other
models while playing!  That is, usage of the Typing Model means you
can only use two models in Quake2 from now on: A default one selected
by you, and the Typing Model itself.  If you try to change models by
using the Multiplayer Setup menu, then the model you choose will only
be in effect until you start talking, whereupon it will disappear and
your selected one will become re-used when you finish talking.  This
is the nature of how the Typing Model works, so if this idea doesn't
appeal to you, then DON'T install the Typing Model.

This model fully supports VWep.



Introduction
------------

You know the story: You're playing online and need to type something
to someone, and BLAM!  Halfway through a sentence you've been fragged.
It's not fair... you've tried facing a wall (which is in fact supposed
to be a recognized signal that you're typing) but there's always that
one player who doesn't care about ethics and still blows you away...
What to do?  Well, hopefully this model and skin is the answer! :)

This model is simply the male/grunt model with one modification: His
eyes have been blindfolded with a thick black cloth and he's wearing a
easy-to-see white garment with a big red "Don't Shoot Me!" circle.
Anyone with half a brain, upon seeing him, should realize that you
don't intend anyone any harm because you're typing.  Then, when you
finish typing, your normal model and skin gets restored the moment you
start walking forward again.  What could be better than that?  :)

If everyone downloads and installs this model, and if everyone agrees
to abide by what it stands for, then perhaps the Quake2 community can
start having mercy on typists.  After all, being fragged while typing
is as much of an issue as campers or the BFG, but we can't do anything
about those... hopefully this model will let us all play fair with the
need to type!  :)



Installation
------------

STEP 1 OF 3:
Drag the "baseq2" folder from this archive onto your "Quake2" folder
and select "Yes" when asked if overwriting is okay.  This will copy
the model and config file to the correct folders for usage.

STEP 2 OF 3:
This step is the most difficult for beginners to understand.  Firstly,
it is important for you to realise that the Typing Model will only
work on Deathmatch games by default.  If you want it to work with CTF
or other mods, such as Jailbreak, Catch The Chicken, etc, then you
will have to follow the installation procedure for every mod you have.
This is not my fault -- it's the way Quake2 works with mods.

Okay, inside the archive next to this document is an "autoexec" file.
To make the Typing Model work, all you have to do is copy this file
to every mod folder that you wish the Typing Model to work in.  BUT...
It is very important NOT to copy this file if you already have a file
called "autoexec" in those mods folders!  That is, you must definitely
NOT overwrite any existing "autoexec" file!  If you do, you may lose
custom game settings that you've previously set up.  If you do have a
file called "autoexec", then you must simply open that existing file
and add this single line to the VERY END of it:

   exec typing.cfg

This line is what activates the Typing Model for use when you talk.
Remember, for every mod that you wish to use the Typing Model, you
must either edit an existing "autoexec" file with the line above (by
putting the line at the very end of it), or copy the "autoexec" file
from this archive into that mod's folder.

STEP 3 of 3:
This final step is again a partial stumbling-block for beginners,
because it requires you to know what key/control you use to move
forward in the game, what model and skin you normally use, and what
key you press to talk.  When you first install Quake2, the defaults
for each of these are:

To move forward = Uparrow key.
Model and skin  = male/grunt.
To talk         = T key.

If you haven't changed any of these, then don't need to do anything
more and the Typing Model will work from this point on.  However, if
you have changed even just one of these, then you must read on.  :)

First, open your "Quake2\Baseq2\" folder and open the "typing" file.
At the bottom of it are these three lines:

   bind t "bind uparrow +typing ; skin typing/typing ; messagemode"
   alias +typing "skin male/grunt ; +forward"
   alias -typing "-forward"

Depending on how you play Quake2, you'll have to change either the
first, or both first and second lines.  The third line is left intact.

For the first line, you must change the "t" (in the "bind t" part) to
the key or control that you normally use when talking in the game.
Most people would leave this set to the "t" key.  However, let's say
you use the "y" key to talk.  In such a case, edit the line so it now
looks like so:

   bind y "bind uparrow +typing ; skin typing/typing ; messagemode"

The next step involves this first line again.  You need to change the
"uparrow" text (between "bind" and "+typing") to your normal key or
control that you use to move forward in the game.  Let's say you
normally use the right mouse button (known as mouse2) to move forward.
In such a case, edit the first line so it looks like so:

   bind y "bind mouse2 +typing ; skin typing/typing ; messagemode"

Let's take another example: Say you use the "w" key to move forward.
You would edit the first line to look like so:

   bind y "bind w +typing ; skin typing/typing ; messagemode"

The final step involves changing the text "male/grunt" in the second
line to your normal skin that you use when playing Quake2.  Let's say
you've downloaded the R2D2 model and use that to play all the time,
and with the R5D4 skin for it.  You would therefore need to edit the
second line so that it changes from this:

   alias +typing "skin male/grunt ; +forward"

to this:

   alias +typing "skin r2d2/r5d4 ; +forward"

Always remember that the model comes first, followed by the skin (so
the format is: model/skin).

At this stage, everything is installed and you can start using the
Typing Model to talk!  :)



Using The Model To Type
-----------------------

If you've completed the installation steps correctly, then all you
have to do is press "t" to type as usual.  But behind the scenes, your
player is now using the Typing Model -- that is, anyone who comes up
to you will see you wearing white and blindfolded.  They can still
shoot you, but it's bad sport if they do; after all, you're wearing
white, which is the recognized symbol for "surrender".  Anyway, once
you've finished typing, you'll still be using the Typing Model until
you start walking forward.  This means you can look around, shoot, or
keep typing, but the second you start moving you become fair game
again!  :)

You'll notice that the first time you hit "t" there might be a small
pause while you change skins, and also when you start moving forward
again.  This is normal and only happens the first time you talk on a
map -- all subsequent skin changes are from the cache and won't cause
the brief stutter.  In fact, after a while you won't even be aware
that you're changing skins every time you type!  :)



Comments About The Model
------------------------

There are in fact three versions of this blindfolded model: A normal
male/grunt and two Capture-The-Flag versions.  This ensures that you
can use the model in almost any Quake2 game or mod.  A point to note
is that the model doesn't get used in Capture-The-Flag when you talk
to your own team (but it still works when you talk to both teams).
This is because you can't expect an enemy team member to have mercy on
you when typing to your own team... after all, you could be relaying
an important tactical message to them!  :)

It's true that you can still shoot when using the Typing Model, but
doing so will get you flamed for bad sportsmanship from other players,
and they will probably start to ignore the Typing Model in future and
frag you anyway for punishment.  So don't do it!  And yes, it is still
possible to keep the Typing Model in use when moving backwards or
strafing, but I don't think this is much of an issue, because you
can't play a whole game without moving forward at some stage.  :)

Some people E-Mailed me and asked why I made it an entirely new model
instead of just a skin for the "players/male" folder.  The reason is
for Capture-The-Flag: If it was just a skin, it wouldn't show up in
CTF because you can't use custom skins in CTF for the male model.
Having it as an entirely new model means that everyone who downloads
it is guaranteed to see it when a player is typing.



Acknowledgment
--------------

Many thanks must go to Peter Ordal (pordal@hotmail.com) who was kind
enough to point out to me the keyboard bug that stopped the model from
working correctly.  Without his warning, this entire project may have
become restricted to players using a mouse or joystick only.  So to
all you keyboarders out there: You got some thanking to do, so send a
nice E-Mail to Peter today!  :)

======================================================================
